fix(om2.0) : do we really need escaping for escaping?#2900
Open
fix(om2.0) : do we really need escaping for escaping?#2900
Conversation
In my VS Code preview and in github https://github.com/prometheus/docs/blob/main/docs/specs/om/open_metrics_spec_2_0.md#escaping the text reads just fine without it. Switch to also "View" of the changed file when reviwing this PR. Signed-off-by: György Krajcsovits <gyorgy.krajcsovits@grafana.com>
dashpole
approved these changes
Mar 18, 2026
bwplotka
approved these changes
Mar 20, 2026
Member
bwplotka
left a comment
bwplotka
left a comment
There was a problem hiding this comment.
LGTM for extra escaping, just I don't understand that sentence properly.
| #### Escaping | ||
|
|
||
| Where the ABNF notes escaping, the following escaping MUST be applied Line feed, `\n` (0x0A) -> literally `\\n` (Bytecode 0x5c 0x6e) Double quotes -> `\\"` (Bytecode 0x5c 0x22) Backslash -> `\\\\` (Bytecode 0x5c 0x5c) | ||
| Where the ABNF notes escaping, the following escaping MUST be applied Line feed, `\n` (0x0A) -> literally `\n` (Bytecode 0x5c 0x6e) Double quotes -> `\"` (Bytecode 0x5c 0x22) Backslash -> `\\` (Bytecode 0x5c 0x5c) |
Member
There was a problem hiding this comment.
"Must be applied Line feed" - this reads weird. Is this a valid English?
Also "Where the ABNF notes escaping," - does it mens "when the ABNF defines the use of escaping"? Can we reword?
What about:
Suggested change
| Where the ABNF notes escaping, the following escaping MUST be applied Line feed, `\n` (0x0A) -> literally `\n` (Bytecode 0x5c 0x6e) Double quotes -> `\"` (Bytecode 0x5c 0x22) Backslash -> `\\` (Bytecode 0x5c 0x5c) | |
| Where the ABNF notes escaping, the following escaping MUST be applied: | |
| * Line feed, `\n` (0x0A) -> literally `\n` (Bytecode 0x5c 0x6e) | |
| * Double quotes -> `\"` (Bytecode 0x5c 0x22) | |
| * Backslash -> `\\` (Bytecode 0x5c 0x5c) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In my VS Code preview and in github
https://github.com/prometheus/docs/blob/main/docs/specs/om/open_metrics_spec_2_0.md#escaping the text reads just fine without it.
Switch to also "View" of the changed file when reviwing this PR.
https://github.com/prometheus/docs/blob/cb119e3af92672b8d8dc6a649e47b64ff3f318f3/docs/specs/om/open_metrics_spec_2_0.md#escaping